/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm.impl;

import cgl.narada.wsinfra.schemas.addressing.ActionDocument;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.addressing.FaultToDocument;
import cgl.narada.wsinfra.schemas.addressing.FromDocument;
import cgl.narada.wsinfra.schemas.addressing.RelatesToDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.schemas.wsrm.CreateSequenceResponseDocument;
import cgl.narada.wsinfra.schemas.wsrm.HandshakeType;
import cgl.narada.wsinfra.util.SoapMessageAlteration;
import cgl.narada.wsinfra.util.XmlContentTransfer;
import cgl.narada.wsinfra.wsa.AddressingHeaders;
import cgl.narada.wsinfra.wsa.WsaEnvelopeCreator;
import cgl.narada.wsinfra.wsa.WsaEprRules;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;
import cgl.narada.wsinfra.wsrm.WsrmActions;
import cgl.narada.wsinfra.wsrm.WsrmResponseCreator;

/** A class which is responsible for creating WSRM requests.
    
    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.3 $
*/


public class WsrmResponseCreatorImpl implements WsrmResponseCreator {
  private static final WsrmResponseCreator instance = new WsrmResponseCreatorImpl();
  private WsrmActions wsrmActions;
  private WsaEprRules wsaEprRules;
  private WsaEnvelopeCreator wsaEnvelopeCreator;
  private SoapMessageAlteration soapMessageAlteration;
  private XmlContentTransfer xmlContentTransfer;
  
  private String moduleName = "WsrmResponseCreator: ";
  

  private WsrmResponseCreatorImpl() {
    wsrmActions = WsrmActions.getInstance();
    wsaEprRules = WsaProcessingFactory.getWsaEprRules();
    wsaEnvelopeCreator = WsaProcessingFactory.getWsaEnvelopeCreator();
    soapMessageAlteration = SoapMessageAlteration.getInstance();
    xmlContentTransfer = XmlContentTransfer.getInstance();
  }


  public static WsrmResponseCreator getInstance() {
    return instance;
  }
  
  
  public EnvelopeDocument
  getCreateSequenceResponse(AddressingHeaders createSequenceRequestHeaders,
			    EndpointReferenceType wsrmSinkEpr,
			    String sequenceIdentifier) {
    EndpointReferenceType to = 
      wsaEprRules.sendTo(createSequenceRequestHeaders);
    if (to == null) {
      System.out.println(moduleName + 
			 "No idea where to send the response to");
      return null;
    }

    if (!createSequenceRequestHeaders.hasMessageID()) {
      System.out.println(moduleName + 
			 "The received message has NO valid messageID");
      return null;
    }
    
    FromDocument from = FromDocument.Factory.newInstance();
    from.setFrom(wsrmSinkEpr);

    ActionDocument action = ActionDocument.Factory.newInstance();
    action.addNewAction().setStringValue(wsrmActions.getCreateSequenceResponse());

    FaultToDocument faultTo = FaultToDocument.Factory.newInstance();
    faultTo.setFaultTo(wsrmSinkEpr);

    String messageId = 
      createSequenceRequestHeaders.getMessageID().getMessageID().getStringValue();
    RelatesToDocument relatesTo = RelatesToDocument.Factory.newInstance();
    relatesTo.addNewRelatesTo().setStringValue(messageId);
    
    
    EnvelopeDocument envelopeDocument = 
      wsaEnvelopeCreator.createSoapEnvelope(to, from, action, relatesTo);

    CreateSequenceResponseDocument createSequenceResponseDocument =
      CreateSequenceResponseDocument.Factory.newInstance();
    
    HandshakeType handshakeType = 
      createSequenceResponseDocument.addNewCreateSequenceResponse();
    handshakeType.addNewIdentifier().setStringValue(sequenceIdentifier);
    
    soapMessageAlteration.addToSoapBody(envelopeDocument, 
					createSequenceResponseDocument);
    return envelopeDocument;
  }  
  
  
  /** Create a CreateSequenceResponse element and add to a previously
      created envelope document. */
  public void
  addCreateSequenceResponse(EnvelopeDocument envelopeDocument,
			    String sequenceIdentifier) {
    
    CreateSequenceResponseDocument createSequenceResponseDocument =
      CreateSequenceResponseDocument.Factory.newInstance();
    
    HandshakeType handshakeType = 
      createSequenceResponseDocument.addNewCreateSequenceResponse();
    handshakeType.addNewIdentifier().setStringValue(sequenceIdentifier);
    
    soapMessageAlteration.addToSoapBody(envelopeDocument, 
					createSequenceResponseDocument);
  }
  
}
